Failure<T>(Exception) Method

Returns a failed value result with given exception.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Overloads Shared Function Failure(Of T)( _
   ByVal exception As Exception _
) As ValueResult(Of T)

'Usage
 
Dim exception As Exception
Dim value As ValueResult(Of T)
 
value = ValueResult.Failure(Of T)(exception)

[NotNull()]
public static ValueResult<T> Failure<T>( 
   Exception exception
)

[NotNull()]
public:
static ValueResult<T^>^ Failuregeneric<typename T>
( 
   Exception^ exception
)

Parameters

exception: Information about the reason of the failure of the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).

Type Parameters

T

Return Value

The failed value result.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

ValueResult Class
ValueResult Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.